<html>
<head>
	<title>Marginalia Demo Manifest</title>
	<style type="text/css">
		ol li {
			margin: 1em 0 ;
		}
	</style>
</head>
<body>
<h1>Marginalia Demo Manifest</h1>

<p>These are the implementation files that should be in this package:</p>

<h2><code>db</code> directory</h2>

<p>These scripts initialize the database.</p>

<dl>
<dt>keywords.sql</dt>
<dd>Predefined keywords for the drop-down list presented while creating and
editing annotations.</dd>

<dt>tables.sql</dt>
<dd>Annotation table definitions.  Most applications will have table
definitions very close to these.</dd>
</dl>

<h2><code>util</code> directory</h2>

<p>These are useful scripts used to construct an application.  They are
not used at runtime.</p>

<dl>

<dt>locale2js.xsl</dt>
<dd>A sample conversion of locale/en_US.xml to produce www/strings.js,
a Javascript file containing localized strings used by Marginalia.  See
the description of locale/en_US.xml in the manifest for the Marginalia
library for details.</dd>

</dl>

<h2><code>www</code> directory</h2>

<dl>

<dt>annotate-db.php</dt>
<dd>Database access code.</dd>

<dt>annotate.php</dt>
<dd>The service handler called when a request is made from any of the
<code>rest-*.js</code> functions in Marginalia.</dd>

<dt>annotation.php</dt>
<dd>A class representing an annotation.</dd>

<dt>example-annotations.php</dt>
<dd>This can be used as a static source of annotations instead of the
database back-end.</dd>

<dt>index.html</dt>
<dd>The application's main HTML page, with the content to be annotated.
Includes extensive comments explaining how things work.</dd>

<dt>marginalia-config.js</dt>
<dd>Configuration settings needed by Marginalia.</dd>

<dt>marginalia-strings.js</dt>
<dd>The file generated by <code>util/locale2js.xsl</code> and included 
in the application to provide localized strings.</dd>

<dt>sample-config.php</dt>
<dd>An example of installation-specific configuration options.  Should
be edited and renamed to <code>config.php</code>.</dd>

<dt>static-annotate.js</dt>
<dd>A substitute for <code>marginalia/rest-annotate.js</code> which uses 
a static XML file instead of calling a back-end.  Useful only for demo 
purposes.</dd>

<dt>static-prefs.js</dt>
<dd>A substitute for <code>marginalia/rest-prefs.js</code> which uses
uses hard-coded preferences instead of calling a back end.  Useful only
for demo purposes.</dd>

<dt>word-range.php</dt>
<dd>Classes representing poinst or ranges in document content.</dd>

<dt>

</dl>


</body>
</html>
